Admin Task Registry entry

Add an admin task to the Admin Tasks module. An Admin Task can be selected by authorized users in the Vitalware client to run a task on the server.

Usage

This Registry entry can be assigned to users and groups:

Key User Group Group
Key 1 User Group Group
Key 2 user group Default
Key 3 Table
Key 4 table
Key 5 Admin Task
Key 6 task
Value script

where:

table

identifies the module heading under which the task will be listed in the Admin Tasks window. The format of table is the table's back-end name (e.g. eparties, emultimedia, etc.), but it will display in the Admin Tasks window as the module name (e.g. Parties, Multimedia).

A special table name of eadmin is used to add entries under the Admin virtual module.

task

is the name of the task as it is listed in the Admin Tasks window under the module heading.

script

is the script that is run when task is selected in the Admin Tasks window.

The format of script is:

{output format} command

where:

{output format}

specifies how output generated by the Admin Task is handled. By default, output will display in an Admin Task Results box. This is an optional value.

command

must be specified. This is the name of the script to be executed on the server. The command should reside in the admin directory on the Vitalware server machine. It is possible to prompt the user for input (arguments) which are passed through to the command. If an {output format} is not supplied, any output generated is displayed in an Admin Task Results box.